Aminet 51/Aminet 51 (2002)(GTI - Schatztruhe)[!][Oct 2002].iso/Aminet/disk/misc/SFSCheck.readme

Text File | 2002-08-17 | 5.8 KB | 184 lines

Short:    Utility to check a SmartFileSystem device structure
Author:   Marcin "Morgoth" Kurek <[e-mail]>
Uploader: Marcin "Morgoth" Kurek <[e-mail]>
Version:  2.3
Type:     disk/misc
Requires: Kickstart 3.0
Replaces: -

--------------- Introduction ---------------

Completly re-written SFSCheck 1.x which can be found
in most SFS distributions. All functions from the old program
are available in this new utility. Additionally there are many new
features and bug fixes.

Although it is not the final version, its functionality
overtakes the original SFSCheck.
There are stil some upgrades to come in the final version.

--------------- Legal ---------------

The author DOES NOT take any responsibility for any damage
occured while using this tool.

 !THERE ARE NO WARRANTIES!

SFSCheck may be freely distributed. It is freeware!

--------------- New Features ---------------

- checks and displays device fragmentation
- able to create a list of fragmented files
- able to create a list of objects with special SFS attributes
- recognizes  volumes given as a argument
- support for locale.library (fully localized)
- displays crucial information about device
- reduced memory fragmentation
- support for CTRL+C command
- ready for MorphOS and/or OS 4.0 (pure C/C++ code)

--------------- Usage ---------------

Template: DEVICE/A,LOCK/S,
FRAGLIST/S,SEEK/S,FP=FULLPATH/S,
L=LINES/N/K,RAHS=READAHEADSIZE/N/K:

Required arguments:

  DEVICE/A: device/volume to check

Optional arguments:

  LOCK/S:  If you specify this parameter, SFScheck locks
           the device/volume for the duration of the scan
           by using by using ACTION_INHIBIT.

  FRAGLIST/S:  If you specify this parameter, SFScheck displays a
               detailed list of fragmented files of the specified
               device/volume with this syntax:

               ...
               Fragmented file: FileName [Object Node Number], number of fragments
               ...

  SEEK/S:  If you specify this parameter, SFScheck displays a
           detailed list of objects with special SFS attributes
           of the specified device/volume with this syntax

           ...
           Object Type: Object Name [Object Node Number] Attributes: [List of Attributes]
           ...

  FP=FULLPATH/S:  If you specify this parameter, SFScheck forces
                  SEEK or FRAGLIST to display the full path of an object;
                                    requires either of these to work

  L=LINES/N/K:  The number of lines SFScheck uses for its cache
                during the check. Default is 128 lines


  RAHS=READAHEADSIZE/N/K:  The size of each cache line;
                           the entered value is treated as the number
                           of kilobytes to use. Default is 8 kb

    example: L=512 RAHS=32 forces SFScheck to use 512 lines, 32 kb each,
             requires 16 MB of free memory (512 * (32 * 1024))


--------------- Notes ---------------

This tool checks a SFS disk's structure and looks for anything which is wrong.
It makes no modifications, it only reads the device.
Any error it finds will be displayed.

You can use this tool to give more detailed information when
reporting bugs to SFS author, but also to convince yourself that the SFS
device is still working smoothly.

If SFScheck reports errors, the best thing to do would be
to backup important files and reformat.

Continous using of a SFS disk with errors will eventually
result in fatal errors which could mean you lose all data on that
device. In that case try to use a SFSSalve utility to recover your data.

Do not run SFScheck when you are writing something to the
disk. SFScheck will get confused (because the structure
changes right under its feet) and reports errors which
are not really there.  This is not dangerous as SFScheck only
reads the disk (it can not repair a disk), but you should be
aware of this when using SFScheck. Use LOCK/S to avoid this.

SFScheck can be used on SFS devices only. Using it on other type
of devices is harmless. SFScheck will simply report that
the device is not in the correct format.

SFScheck returns following values:

- 0  (OK)    - everything is OK
- 5  (WARN)  - CTRL+C break detected
- 10 (ERROR) - wrong command line argument
- 20 (FAIL)  - scan error occured (bad block, cache error, SFS fails?)

--------------- History ---------------

2.3 (26.07.2002) - First public release.

--------------- ToDo ---------------

- GUI
- ALL/S - seek&check all SFS devices
- MorphOS version
- QUICK/S - skip scanning and seek special/fagmented files
- integration of a defragmentation utility
- repair SFS devices
- find the rest of the bugs ;)

--------------- ThX ---------------

John Hendrikx   - For wonderful SFS of coz :)
Jörg Strohmayer - For keep it alive

Adam "Vaghax" Potempa - For help with this manual

All people from #MorphOS canal for many help not olny in development of this tool

All people from my Beta Team (in alphabetically order)
- Duncan Gow,
- Dietmar Lakotta,
- Daniel Rangel,
- Enrique R. Mecklenburg Serkovic,
- Henri,
- Jarek  "Ajuô"  Balcer,
- Jerome Chesnot,
- Mathias Uhlig,
- OPI,
- P-O Yliniemi,
- Thomas Igracki,
- Tony van Haarlem,
- Zapek

Translators:

- Daniel Rangel <[e-mail]> - Spanish Translation *MISSING*
- Enrique R. Mecklenburg Serkovic <[e-mail]> - Spanish Translation *MISSING*
- Jerome Chesnot <[e-mail]> - French Translation
- Mathias Uhlig <[e-mail]> - German Translation *MISSING*
- Thomas Igracki <[e-mail]> German Translation
- Jaroslaw Balcer <[e-mail]> - Polish Translation *MISSING*

All people that I forgot :(

--------------- Support ---------------

Feel free to send me your suggestions and/or bug reports.

--------------- Author ---------------

Marcin "Morgoth" Kurek

[e-mail]

--------------------------------------